/**
 * Copyright (C) 2007-2009 Carnegie Mellon University and others.
 *
 * This file is part of Plural.
 *
 * Plural is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as 
 * published by the Free Software Foundation.
 *
 * Plural is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Plural; if not, see <http://www.gnu.org/licenses>.
 *
 * Linking Plural statically or dynamically with other modules is
 * making a combined work based on Plural. Thus, the terms and
 * conditions of the GNU General Public License cover the whole
 * combination.
 *
 * In addition, as a special exception, the copyright holders of Plural
 * give you permission to combine Plural with free software programs or
 * libraries that are released under the GNU LGPL and with code
 * included in the standard release of Eclipse under the Eclipse Public
 * License (or modified versions of such code, with unchanged license).
 * You may copy and distribute such a system following the terms of the
 * GNU GPL for Plural and the licenses of the other code concerned.
 *
 * Note that people who make modified versions of Plural are not
 * obligated to grant this special exception for their modified
 * versions; it is their choice whether to do so. The GNU General
 * Public License gives permission to release a modified version
 * without this exception; this exception also makes it possible to
 * release a modified version which carries forward this exception.
 */

package edu.cmu.cs.plural.polymorphic.internal;

import edu.cmu.cs.crystal.analysis.alias.Aliasing;
import edu.cmu.cs.crystal.simple.TupleLatticeElement;
import edu.cmu.cs.crystal.util.Option;

/**
 * The lattice for the poly internal checker. It is essentially a
 * tuple lattice but it also contains information about whether or
 * not the receiver is unpacked.
 * 
 * @author Nels E. Beckman
 * @since Dec 9, 2009
 *
 */
public final class PolyTupleLattice {

	private final TupleLatticeElement<Aliasing, PolyVarLE> tupleLattice;
	private PackedNess isRcvrUnpacked;
	
	enum PackedNess {
		TOP, BOTTOM, PACKED, UNPACKED
	}
	
	public PolyTupleLattice(TupleLatticeElement<Aliasing, PolyVarLE> tupleLattice,
			PackedNess packedness) {
		this.tupleLattice = tupleLattice;
		this.isRcvrUnpacked = packedness;
	}

	/**
	 * Put a value into the tuple.
	 */
	public void put(Aliasing loc, PolyVarLE le) {
		this.tupleLattice.put(loc, le);
	}

	/**
	 * Get a value from the tuple.
	 */
	public PolyVarLE get(Aliasing argLoc) {
		return this.tupleLattice.get(argLoc);
	}

	TupleLatticeElement<Aliasing, PolyVarLE> getTuple() {
		return this.tupleLattice;
	}

	/**
	 * @return
	 */
	PackedNess getPackedness() {
		return this.isRcvrUnpacked;
	}

	/**
	 * @param unpacked
	 */
	public void setPackedness(PackedNess unpacked) {
		this.isRcvrUnpacked = unpacked;
	}
}
